<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>XPathExpressionEngine xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> * the License.  You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> *     <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  <strong class="jxr_keyword">package</strong> org.apache.commons.configuration.tree.xpath;
<a class="jxr_linenumber" name="18" href="#18">18</a>  
<a class="jxr_linenumber" name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> java.util.Collections;
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.util.StringTokenizer;
<a class="jxr_linenumber" name="22" href="#22">22</a>  
<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.tree.ConfigurationNode;
<a class="jxr_linenumber" name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.tree.ExpressionEngine;
<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.configuration.tree.NodeAddData;
<a class="jxr_linenumber" name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.jxpath.JXPathContext;
<a class="jxr_linenumber" name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.jxpath.ri.JXPathContextReferenceImpl;
<a class="jxr_linenumber" name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
<a class="jxr_linenumber" name="29" href="#29">29</a>  
<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * A specialized implementation of the {@code ExpressionEngine} interface</em>
<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * that is able to evaluate XPATH expressions.</em>
<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * This class makes use of &lt;a href="<a href="http://commons.apache.org/jxpath/" target="alexandria_uri">http://commons.apache.org/jxpath/</a>"&gt; Commons</em>
<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * JXPath&lt;/a&gt; for handling XPath expressions and mapping them to the nodes of a</em>
<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * hierarchical configuration. This makes the rich and powerful XPATH syntax</em>
<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * available for accessing properties from a configuration object.</em>
<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * For selecting properties arbitrary XPATH expressions can be used, which</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * select single or multiple configuration nodes. The associated</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * {@code Configuration} instance will directly pass the specified property</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * keys into this engine. If a key is not syntactically correct, an exception</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * will be thrown.</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * For adding new properties, this expression engine uses a specific syntax: the</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * &amp;quot;key&amp;quot; of a new property must consist of two parts that are</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * separated by whitespace:</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * &lt;ol&gt;</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;An XPATH expression selecting a single node, to which the new element(s)</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * are to be added. This can be an arbitrary complex expression, but it must</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * select exactly one node, otherwise an exception will be thrown.&lt;/li&gt;</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;The name of the new element(s) to be added below this parent node. Here</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> * either a single node name or a complete path of nodes (separated by the</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * &amp;quot;/&amp;quot; character or &amp;quot;@&amp;quot; for an attribute) can be specified.&lt;/li&gt;</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> * &lt;/ol&gt;</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> * Some examples for valid keys that can be passed into the configuration's</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment"> * {@code addProperty()} method follow:</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment"> * &amp;quot;/tables/table[1] type&amp;quot;</em>
<a class="jxr_linenumber" name="67" href="#67">67</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="68" href="#68">68</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="69" href="#69">69</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="70" href="#70">70</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment"> * This will add a new {@code type} node as a child of the first</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment"> * {@code table} element.</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment"> * &amp;quot;/tables/table[1] @type&amp;quot;</em>
<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment"> * Similar to the example above, but this time a new attribute named</em>
<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment"> * {@code type} will be added to the first {@code table} element.</em>
<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="85" href="#85">85</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="86" href="#86">86</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="87" href="#87">87</a>  <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="88" href="#88">88</a>  <em class="jxr_javadoccomment"> * &amp;quot;/tables table/fields/field/name&amp;quot;</em>
<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="91" href="#91">91</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="93" href="#93">93</a>  <em class="jxr_javadoccomment"> * This example shows how a complex path can be added. Parent node is the</em>
<a class="jxr_linenumber" name="94" href="#94">94</a>  <em class="jxr_javadoccomment"> * {@code tables} element. Here a new branch consisting of the nodes</em>
<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment"> * {@code table}, {@code fields}, {@code field}, and</em>
<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment"> * {@code name} will be added.</em>
<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * &amp;quot;/tables table/fields/field@type&amp;quot;</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * This is similar to the last example, but in this case a complex path ending</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * with an attribute is defined.</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * &lt;strong&gt;Note:&lt;/strong&gt; This extended syntax for adding properties only works</em>
<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * with the {@code addProperty()} method. {@code setProperty()} does</em>
<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * not support creating new nodes this way.</em>
<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * From version 1.7 on, it is possible to use regular keys in calls to</em>
<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * {@code addProperty()} (i.e. keys that do not have to contain a</em>
<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * whitespace as delimiter). In this case the key is evaluated, and the biggest</em>
<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * part pointing to an existing node is determined. The remaining part is then</em>
<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * added as new path. As an example consider the key</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * &amp;quot;tables/table[last()]/fields/field/name&amp;quot;</em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * If the key does not point to an existing node, the engine will check the</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * paths {@code "tables/table[last()]/fields/field"},</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * {@code "tables/table[last()]/fields"},</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * {@code "tables/table[last()]"}, and so on, until a key is</em>
<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * found which points to a node. Let's assume that the last key listed above can</em>
<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * be resolved in this way. Then from this key the following key is derived:</em>
<a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * {@code "tables/table[last()] fields/field/name"} by appending</em>
<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * the remaining part after a whitespace. This key can now be processed using</em>
<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * the original algorithm. Keys of this form can also be used with the</em>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * {@code setProperty()} method. However, it is still recommended to use</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * the old format because it makes explicit at which position new nodes should</em>
<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * be added. For keys without a whitespace delimiter there may be ambiguities.</em>
<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="138" href="#138">138</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @since 1.3</em>
<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * @author &lt;a</em>
<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment"> *         href="<a href="http://commons.apache.org/configuration/team-list.html" target="alexandria_uri">http://commons.apache.org/configuration/team-list.html</a>"&gt;Commons</em>
<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment"> *         Configuration team&lt;/a&gt;</em>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @version $Id: XPathExpressionEngine.java 1206563 2011-11-26 19:47:26Z oheger $</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/commons/configuration/tree/xpath/XPathExpressionEngine.html">XPathExpressionEngine</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../org/apache/commons/configuration/tree/ExpressionEngine.html">ExpressionEngine</a>
<a class="jxr_linenumber" name="146" href="#146">146</a> {
<a class="jxr_linenumber" name="147" href="#147">147</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the path delimiter. */</em>
<a class="jxr_linenumber" name="148" href="#148">148</a>     <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PATH_DELIMITER = <span class="jxr_string">"/"</span>;
<a class="jxr_linenumber" name="149" href="#149">149</a> 
<a class="jxr_linenumber" name="150" href="#150">150</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the attribute delimiter. */</em>
<a class="jxr_linenumber" name="151" href="#151">151</a>     <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ATTR_DELIMITER = <span class="jxr_string">"@"</span>;
<a class="jxr_linenumber" name="152" href="#152">152</a> 
<a class="jxr_linenumber" name="153" href="#153">153</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the delimiters for splitting node paths. */</em>
<a class="jxr_linenumber" name="154" href="#154">154</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NODE_PATH_DELIMITERS = PATH_DELIMITER
<a class="jxr_linenumber" name="155" href="#155">155</a>             + ATTR_DELIMITER;
<a class="jxr_linenumber" name="156" href="#156">156</a> 
<a class="jxr_linenumber" name="157" href="#157">157</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment">     * Constant for a space which is used as delimiter in keys for adding</em>
<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * properties.</em>
<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="161" href="#161">161</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SPACE = <span class="jxr_string">" "</span>;
<a class="jxr_linenumber" name="162" href="#162">162</a> 
<a class="jxr_linenumber" name="163" href="#163">163</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment">     * Executes a query. The passed in property key is directly passed to a</em>
<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment">     * JXPath context.</em>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment">     * @param root the configuration root node</em>
<a class="jxr_linenumber" name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * @param key the query to be executed</em>
<a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_javadoccomment">     * @return a list with the nodes that are selected by the query</em>
<a class="jxr_linenumber" name="170" href="#170">170</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="171" href="#171">171</a>     <strong class="jxr_keyword">public</strong> List&lt;ConfigurationNode&gt; query(<a href="../../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> root, String key)
<a class="jxr_linenumber" name="172" href="#172">172</a>     {
<a class="jxr_linenumber" name="173" href="#173">173</a>         <strong class="jxr_keyword">if</strong> (StringUtils.isEmpty(key))
<a class="jxr_linenumber" name="174" href="#174">174</a>         {
<a class="jxr_linenumber" name="175" href="#175">175</a>             <strong class="jxr_keyword">return</strong> Collections.singletonList(root);
<a class="jxr_linenumber" name="176" href="#176">176</a>         }
<a class="jxr_linenumber" name="177" href="#177">177</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="178" href="#178">178</a>         {
<a class="jxr_linenumber" name="179" href="#179">179</a>             JXPathContext context = createContext(root, key);
<a class="jxr_linenumber" name="180" href="#180">180</a>             <em class="jxr_comment">// This is safe because our node pointer implementations will return</em>
<a class="jxr_linenumber" name="181" href="#181">181</a>             <em class="jxr_comment">// a list of configuration nodes.</em>
<a class="jxr_linenumber" name="182" href="#182">182</a>             @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="183" href="#183">183</a>             List&lt;ConfigurationNode&gt; result = context.selectNodes(key);
<a class="jxr_linenumber" name="184" href="#184">184</a>             <strong class="jxr_keyword">if</strong> (result == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="185" href="#185">185</a>             {
<a class="jxr_linenumber" name="186" href="#186">186</a>                 result = Collections.emptyList();
<a class="jxr_linenumber" name="187" href="#187">187</a>             }
<a class="jxr_linenumber" name="188" href="#188">188</a>             <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="189" href="#189">189</a>         }
<a class="jxr_linenumber" name="190" href="#190">190</a>     }
<a class="jxr_linenumber" name="191" href="#191">191</a> 
<a class="jxr_linenumber" name="192" href="#192">192</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment">     * Returns a (canonical) key for the given node based on the parent's key.</em>
<a class="jxr_linenumber" name="194" href="#194">194</a> <em class="jxr_javadoccomment">     * This implementation will create an XPATH expression that selects the</em>
<a class="jxr_linenumber" name="195" href="#195">195</a> <em class="jxr_javadoccomment">     * given node (under the assumption that the passed in parent key is valid).</em>
<a class="jxr_linenumber" name="196" href="#196">196</a> <em class="jxr_javadoccomment">     * As the {@code nodeKey()} implementation of</em>
<a class="jxr_linenumber" name="197" href="#197">197</a> <em class="jxr_javadoccomment">     * {@link org.apache.commons.configuration.tree.DefaultExpressionEngine DefaultExpressionEngine}</em>
<a class="jxr_linenumber" name="198" href="#198">198</a> <em class="jxr_javadoccomment">     * this method will not return indices for nodes. So all child nodes of a</em>
<a class="jxr_linenumber" name="199" href="#199">199</a> <em class="jxr_javadoccomment">     * given parent with the same name will have the same key.</em>
<a class="jxr_linenumber" name="200" href="#200">200</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="201" href="#201">201</a> <em class="jxr_javadoccomment">     * @param node the node for which a key is to be constructed</em>
<a class="jxr_linenumber" name="202" href="#202">202</a> <em class="jxr_javadoccomment">     * @param parentKey the key of the parent node</em>
<a class="jxr_linenumber" name="203" href="#203">203</a> <em class="jxr_javadoccomment">     * @return the key for the given node</em>
<a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="205" href="#205">205</a>     <strong class="jxr_keyword">public</strong> String nodeKey(<a href="../../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> node, String parentKey)
<a class="jxr_linenumber" name="206" href="#206">206</a>     {
<a class="jxr_linenumber" name="207" href="#207">207</a>         <strong class="jxr_keyword">if</strong> (parentKey == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="208" href="#208">208</a>         {
<a class="jxr_linenumber" name="209" href="#209">209</a>             <em class="jxr_comment">// name of the root node</em>
<a class="jxr_linenumber" name="210" href="#210">210</a>             <strong class="jxr_keyword">return</strong> StringUtils.EMPTY;
<a class="jxr_linenumber" name="211" href="#211">211</a>         }
<a class="jxr_linenumber" name="212" href="#212">212</a>         <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (node.getName() == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="213" href="#213">213</a>         {
<a class="jxr_linenumber" name="214" href="#214">214</a>             <em class="jxr_comment">// paranoia check for undefined node names</em>
<a class="jxr_linenumber" name="215" href="#215">215</a>             <strong class="jxr_keyword">return</strong> parentKey;
<a class="jxr_linenumber" name="216" href="#216">216</a>         }
<a class="jxr_linenumber" name="217" href="#217">217</a> 
<a class="jxr_linenumber" name="218" href="#218">218</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="219" href="#219">219</a>         {
<a class="jxr_linenumber" name="220" href="#220">220</a>             StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder(parentKey.length()
<a class="jxr_linenumber" name="221" href="#221">221</a>                     + node.getName().length() + PATH_DELIMITER.length());
<a class="jxr_linenumber" name="222" href="#222">222</a>             <strong class="jxr_keyword">if</strong> (parentKey.length() &gt; 0)
<a class="jxr_linenumber" name="223" href="#223">223</a>             {
<a class="jxr_linenumber" name="224" href="#224">224</a>                 buf.append(parentKey);
<a class="jxr_linenumber" name="225" href="#225">225</a>                 buf.append(PATH_DELIMITER);
<a class="jxr_linenumber" name="226" href="#226">226</a>             }
<a class="jxr_linenumber" name="227" href="#227">227</a>             <strong class="jxr_keyword">if</strong> (node.isAttribute())
<a class="jxr_linenumber" name="228" href="#228">228</a>             {
<a class="jxr_linenumber" name="229" href="#229">229</a>                 buf.append(ATTR_DELIMITER);
<a class="jxr_linenumber" name="230" href="#230">230</a>             }
<a class="jxr_linenumber" name="231" href="#231">231</a>             buf.append(node.getName());
<a class="jxr_linenumber" name="232" href="#232">232</a>             <strong class="jxr_keyword">return</strong> buf.toString();
<a class="jxr_linenumber" name="233" href="#233">233</a>         }
<a class="jxr_linenumber" name="234" href="#234">234</a>     }
<a class="jxr_linenumber" name="235" href="#235">235</a> 
<a class="jxr_linenumber" name="236" href="#236">236</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="237" href="#237">237</a> <em class="jxr_javadoccomment">     * Prepares an add operation for a configuration property. The expected</em>
<a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_javadoccomment">     * format of the passed in key is explained in the class comment.</em>
<a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="240" href="#240">240</a> <em class="jxr_javadoccomment">     * @param root the configuration's root node</em>
<a class="jxr_linenumber" name="241" href="#241">241</a> <em class="jxr_javadoccomment">     * @param key the key describing the target of the add operation and the</em>
<a class="jxr_linenumber" name="242" href="#242">242</a> <em class="jxr_javadoccomment">     * path of the new node</em>
<a class="jxr_linenumber" name="243" href="#243">243</a> <em class="jxr_javadoccomment">     * @return a data object to be evaluated by the calling configuration object</em>
<a class="jxr_linenumber" name="244" href="#244">244</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="245" href="#245">245</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/commons/configuration/tree/NodeAddData.html">NodeAddData</a> prepareAdd(<a href="../../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> root, String key)
<a class="jxr_linenumber" name="246" href="#246">246</a>     {
<a class="jxr_linenumber" name="247" href="#247">247</a>         <strong class="jxr_keyword">if</strong> (key == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="248" href="#248">248</a>         {
<a class="jxr_linenumber" name="249" href="#249">249</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a class="jxr_linenumber" name="250" href="#250">250</a>                     <span class="jxr_string">"prepareAdd: key must not be null!"</span>);
<a class="jxr_linenumber" name="251" href="#251">251</a>         }
<a class="jxr_linenumber" name="252" href="#252">252</a> 
<a class="jxr_linenumber" name="253" href="#253">253</a>         String addKey = key;
<a class="jxr_linenumber" name="254" href="#254">254</a>         <strong class="jxr_keyword">int</strong> index = findKeySeparator(addKey);
<a class="jxr_linenumber" name="255" href="#255">255</a>         <strong class="jxr_keyword">if</strong> (index &lt; 0)
<a class="jxr_linenumber" name="256" href="#256">256</a>         {
<a class="jxr_linenumber" name="257" href="#257">257</a>             addKey = generateKeyForAdd(root, addKey);
<a class="jxr_linenumber" name="258" href="#258">258</a>             index = findKeySeparator(addKey);
<a class="jxr_linenumber" name="259" href="#259">259</a>         }
<a class="jxr_linenumber" name="260" href="#260">260</a> 
<a class="jxr_linenumber" name="261" href="#261">261</a>         List&lt;ConfigurationNode&gt; nodes = query(root, addKey.substring(0, index).trim());
<a class="jxr_linenumber" name="262" href="#262">262</a>         <strong class="jxr_keyword">if</strong> (nodes.size() != 1)
<a class="jxr_linenumber" name="263" href="#263">263</a>         {
<a class="jxr_linenumber" name="264" href="#264">264</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a class="jxr_linenumber" name="265" href="#265">265</a>                     <span class="jxr_string">"prepareAdd: key must select exactly one target node!"</span>);
<a class="jxr_linenumber" name="266" href="#266">266</a>         }
<a class="jxr_linenumber" name="267" href="#267">267</a> 
<a class="jxr_linenumber" name="268" href="#268">268</a>         <a href="../../../../../../org/apache/commons/configuration/tree/NodeAddData.html">NodeAddData</a> data = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/configuration/tree/NodeAddData.html">NodeAddData</a>();
<a class="jxr_linenumber" name="269" href="#269">269</a>         data.setParent(nodes.get(0));
<a class="jxr_linenumber" name="270" href="#270">270</a>         initNodeAddData(data, addKey.substring(index).trim());
<a class="jxr_linenumber" name="271" href="#271">271</a>         <strong class="jxr_keyword">return</strong> data;
<a class="jxr_linenumber" name="272" href="#272">272</a>     }
<a class="jxr_linenumber" name="273" href="#273">273</a> 
<a class="jxr_linenumber" name="274" href="#274">274</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="275" href="#275">275</a> <em class="jxr_javadoccomment">     * Creates the {@code JXPathContext} used for executing a query. This</em>
<a class="jxr_linenumber" name="276" href="#276">276</a> <em class="jxr_javadoccomment">     * method will create a new context and ensure that it is correctly</em>
<a class="jxr_linenumber" name="277" href="#277">277</a> <em class="jxr_javadoccomment">     * initialized.</em>
<a class="jxr_linenumber" name="278" href="#278">278</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="279" href="#279">279</a> <em class="jxr_javadoccomment">     * @param root the configuration root node</em>
<a class="jxr_linenumber" name="280" href="#280">280</a> <em class="jxr_javadoccomment">     * @param key the key to be queried</em>
<a class="jxr_linenumber" name="281" href="#281">281</a> <em class="jxr_javadoccomment">     * @return the new context</em>
<a class="jxr_linenumber" name="282" href="#282">282</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="283" href="#283">283</a>     <strong class="jxr_keyword">protected</strong> JXPathContext createContext(<a href="../../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> root, String key)
<a class="jxr_linenumber" name="284" href="#284">284</a>     {
<a class="jxr_linenumber" name="285" href="#285">285</a>         JXPathContext context = JXPathContext.newContext(root);
<a class="jxr_linenumber" name="286" href="#286">286</a>         context.setLenient(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="287" href="#287">287</a>         <strong class="jxr_keyword">return</strong> context;
<a class="jxr_linenumber" name="288" href="#288">288</a>     }
<a class="jxr_linenumber" name="289" href="#289">289</a> 
<a class="jxr_linenumber" name="290" href="#290">290</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="291" href="#291">291</a> <em class="jxr_javadoccomment">     * Initializes most properties of a {@code NodeAddData} object. This</em>
<a class="jxr_linenumber" name="292" href="#292">292</a> <em class="jxr_javadoccomment">     * method is called by {@code prepareAdd()} after the parent node has</em>
<a class="jxr_linenumber" name="293" href="#293">293</a> <em class="jxr_javadoccomment">     * been found. Its task is to interpret the passed in path of the new node.</em>
<a class="jxr_linenumber" name="294" href="#294">294</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="295" href="#295">295</a> <em class="jxr_javadoccomment">     * @param data the data object to initialize</em>
<a class="jxr_linenumber" name="296" href="#296">296</a> <em class="jxr_javadoccomment">     * @param path the path of the new node</em>
<a class="jxr_linenumber" name="297" href="#297">297</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="298" href="#298">298</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initNodeAddData(<a href="../../../../../../org/apache/commons/configuration/tree/NodeAddData.html">NodeAddData</a> data, String path)
<a class="jxr_linenumber" name="299" href="#299">299</a>     {
<a class="jxr_linenumber" name="300" href="#300">300</a>         String lastComponent = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="301" href="#301">301</a>         <strong class="jxr_keyword">boolean</strong> attr = false;
<a class="jxr_linenumber" name="302" href="#302">302</a>         <strong class="jxr_keyword">boolean</strong> first = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="303" href="#303">303</a> 
<a class="jxr_linenumber" name="304" href="#304">304</a>         StringTokenizer tok = <strong class="jxr_keyword">new</strong> StringTokenizer(path, NODE_PATH_DELIMITERS,
<a class="jxr_linenumber" name="305" href="#305">305</a>                 <strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="306" href="#306">306</a>         <strong class="jxr_keyword">while</strong> (tok.hasMoreTokens())
<a class="jxr_linenumber" name="307" href="#307">307</a>         {
<a class="jxr_linenumber" name="308" href="#308">308</a>             String token = tok.nextToken();
<a class="jxr_linenumber" name="309" href="#309">309</a>             <strong class="jxr_keyword">if</strong> (PATH_DELIMITER.equals(token))
<a class="jxr_linenumber" name="310" href="#310">310</a>             {
<a class="jxr_linenumber" name="311" href="#311">311</a>                 <strong class="jxr_keyword">if</strong> (attr)
<a class="jxr_linenumber" name="312" href="#312">312</a>                 {
<a class="jxr_linenumber" name="313" href="#313">313</a>                     invalidPath(path, <span class="jxr_string">" contains an attribute"</span>
<a class="jxr_linenumber" name="314" href="#314">314</a>                             + <span class="jxr_string">" delimiter at an unallowed position."</span>);
<a class="jxr_linenumber" name="315" href="#315">315</a>                 }
<a class="jxr_linenumber" name="316" href="#316">316</a>                 <strong class="jxr_keyword">if</strong> (lastComponent == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="317" href="#317">317</a>                 {
<a class="jxr_linenumber" name="318" href="#318">318</a>                     invalidPath(path,
<a class="jxr_linenumber" name="319" href="#319">319</a>                             <span class="jxr_string">" contains a '/' at an unallowed position."</span>);
<a class="jxr_linenumber" name="320" href="#320">320</a>                 }
<a class="jxr_linenumber" name="321" href="#321">321</a>                 data.addPathNode(lastComponent);
<a class="jxr_linenumber" name="322" href="#322">322</a>                 lastComponent = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="323" href="#323">323</a>             }
<a class="jxr_linenumber" name="324" href="#324">324</a> 
<a class="jxr_linenumber" name="325" href="#325">325</a>             <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (ATTR_DELIMITER.equals(token))
<a class="jxr_linenumber" name="326" href="#326">326</a>             {
<a class="jxr_linenumber" name="327" href="#327">327</a>                 <strong class="jxr_keyword">if</strong> (attr)
<a class="jxr_linenumber" name="328" href="#328">328</a>                 {
<a class="jxr_linenumber" name="329" href="#329">329</a>                     invalidPath(path,
<a class="jxr_linenumber" name="330" href="#330">330</a>                             <span class="jxr_string">" contains multiple attribute delimiters."</span>);
<a class="jxr_linenumber" name="331" href="#331">331</a>                 }
<a class="jxr_linenumber" name="332" href="#332">332</a>                 <strong class="jxr_keyword">if</strong> (lastComponent == <strong class="jxr_keyword">null</strong> &amp;&amp; !first)
<a class="jxr_linenumber" name="333" href="#333">333</a>                 {
<a class="jxr_linenumber" name="334" href="#334">334</a>                     invalidPath(path,
<a class="jxr_linenumber" name="335" href="#335">335</a>                             <span class="jxr_string">" contains an attribute delimiter at an unallowed position."</span>);
<a class="jxr_linenumber" name="336" href="#336">336</a>                 }
<a class="jxr_linenumber" name="337" href="#337">337</a>                 <strong class="jxr_keyword">if</strong> (lastComponent != <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="338" href="#338">338</a>                 {
<a class="jxr_linenumber" name="339" href="#339">339</a>                     data.addPathNode(lastComponent);
<a class="jxr_linenumber" name="340" href="#340">340</a>                 }
<a class="jxr_linenumber" name="341" href="#341">341</a>                 attr = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="342" href="#342">342</a>                 lastComponent = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="343" href="#343">343</a>             }
<a class="jxr_linenumber" name="344" href="#344">344</a> 
<a class="jxr_linenumber" name="345" href="#345">345</a>             <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="346" href="#346">346</a>             {
<a class="jxr_linenumber" name="347" href="#347">347</a>                 lastComponent = token;
<a class="jxr_linenumber" name="348" href="#348">348</a>             }
<a class="jxr_linenumber" name="349" href="#349">349</a>             first = false;
<a class="jxr_linenumber" name="350" href="#350">350</a>         }
<a class="jxr_linenumber" name="351" href="#351">351</a> 
<a class="jxr_linenumber" name="352" href="#352">352</a>         <strong class="jxr_keyword">if</strong> (lastComponent == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="353" href="#353">353</a>         {
<a class="jxr_linenumber" name="354" href="#354">354</a>             invalidPath(path, <span class="jxr_string">"contains no components."</span>);
<a class="jxr_linenumber" name="355" href="#355">355</a>         }
<a class="jxr_linenumber" name="356" href="#356">356</a>         data.setNewNodeName(lastComponent);
<a class="jxr_linenumber" name="357" href="#357">357</a>         data.setAttribute(attr);
<a class="jxr_linenumber" name="358" href="#358">358</a>     }
<a class="jxr_linenumber" name="359" href="#359">359</a> 
<a class="jxr_linenumber" name="360" href="#360">360</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="361" href="#361">361</a> <em class="jxr_javadoccomment">     * Tries to generate a key for adding a property. This method is called if a</em>
<a class="jxr_linenumber" name="362" href="#362">362</a> <em class="jxr_javadoccomment">     * key was used for adding properties which does not contain a space</em>
<a class="jxr_linenumber" name="363" href="#363">363</a> <em class="jxr_javadoccomment">     * character. It splits the key at its single components and searches for</em>
<a class="jxr_linenumber" name="364" href="#364">364</a> <em class="jxr_javadoccomment">     * the last existing component. Then a key compatible for adding properties</em>
<a class="jxr_linenumber" name="365" href="#365">365</a> <em class="jxr_javadoccomment">     * is generated.</em>
<a class="jxr_linenumber" name="366" href="#366">366</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="367" href="#367">367</a> <em class="jxr_javadoccomment">     * @param root the root node of the configuration</em>
<a class="jxr_linenumber" name="368" href="#368">368</a> <em class="jxr_javadoccomment">     * @param key the key in question</em>
<a class="jxr_linenumber" name="369" href="#369">369</a> <em class="jxr_javadoccomment">     * @return the key to be used for adding the property</em>
<a class="jxr_linenumber" name="370" href="#370">370</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="371" href="#371">371</a>     <strong class="jxr_keyword">private</strong> String generateKeyForAdd(<a href="../../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> root, String key)
<a class="jxr_linenumber" name="372" href="#372">372</a>     {
<a class="jxr_linenumber" name="373" href="#373">373</a>         <strong class="jxr_keyword">int</strong> pos = key.lastIndexOf(PATH_DELIMITER, key.length());
<a class="jxr_linenumber" name="374" href="#374">374</a> 
<a class="jxr_linenumber" name="375" href="#375">375</a>         <strong class="jxr_keyword">while</strong> (pos &gt;= 0)
<a class="jxr_linenumber" name="376" href="#376">376</a>         {
<a class="jxr_linenumber" name="377" href="#377">377</a>             String keyExisting = key.substring(0, pos);
<a class="jxr_linenumber" name="378" href="#378">378</a>             <strong class="jxr_keyword">if</strong> (!query(root, keyExisting).isEmpty())
<a class="jxr_linenumber" name="379" href="#379">379</a>             {
<a class="jxr_linenumber" name="380" href="#380">380</a>                 StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder(key.length() + 1);
<a class="jxr_linenumber" name="381" href="#381">381</a>                 buf.append(keyExisting).append(SPACE);
<a class="jxr_linenumber" name="382" href="#382">382</a>                 buf.append(key.substring(pos + 1));
<a class="jxr_linenumber" name="383" href="#383">383</a>                 <strong class="jxr_keyword">return</strong> buf.toString();
<a class="jxr_linenumber" name="384" href="#384">384</a>             }
<a class="jxr_linenumber" name="385" href="#385">385</a>             pos = key.lastIndexOf(PATH_DELIMITER, pos - 1);
<a class="jxr_linenumber" name="386" href="#386">386</a>         }
<a class="jxr_linenumber" name="387" href="#387">387</a> 
<a class="jxr_linenumber" name="388" href="#388">388</a>         <strong class="jxr_keyword">return</strong> SPACE + key;
<a class="jxr_linenumber" name="389" href="#389">389</a>     }
<a class="jxr_linenumber" name="390" href="#390">390</a> 
<a class="jxr_linenumber" name="391" href="#391">391</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="392" href="#392">392</a> <em class="jxr_javadoccomment">     * Helper method for throwing an exception about an invalid path.</em>
<a class="jxr_linenumber" name="393" href="#393">393</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="394" href="#394">394</a> <em class="jxr_javadoccomment">     * @param path the invalid path</em>
<a class="jxr_linenumber" name="395" href="#395">395</a> <em class="jxr_javadoccomment">     * @param msg the exception message</em>
<a class="jxr_linenumber" name="396" href="#396">396</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="397" href="#397">397</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> invalidPath(String path, String msg)
<a class="jxr_linenumber" name="398" href="#398">398</a>     {
<a class="jxr_linenumber" name="399" href="#399">399</a>         <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Invalid node path: \&quot;"</span> + path
<a class="jxr_linenumber" name="400" href="#400">400</a>                 + <span class="jxr_string">"\&quot; "</span> + msg);
<a class="jxr_linenumber" name="401" href="#401">401</a>     }
<a class="jxr_linenumber" name="402" href="#402">402</a> 
<a class="jxr_linenumber" name="403" href="#403">403</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="404" href="#404">404</a> <em class="jxr_javadoccomment">     * Determines the position of the separator in a key for adding new</em>
<a class="jxr_linenumber" name="405" href="#405">405</a> <em class="jxr_javadoccomment">     * properties. If no delimiter is found, result is -1.</em>
<a class="jxr_linenumber" name="406" href="#406">406</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="407" href="#407">407</a> <em class="jxr_javadoccomment">     * @param key the key</em>
<a class="jxr_linenumber" name="408" href="#408">408</a> <em class="jxr_javadoccomment">     * @return the position of the delimiter</em>
<a class="jxr_linenumber" name="409" href="#409">409</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="410" href="#410">410</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> findKeySeparator(String key)
<a class="jxr_linenumber" name="411" href="#411">411</a>     {
<a class="jxr_linenumber" name="412" href="#412">412</a>         <strong class="jxr_keyword">int</strong> index = key.length() - 1;
<a class="jxr_linenumber" name="413" href="#413">413</a>         <strong class="jxr_keyword">while</strong> (index &gt;= 0 &amp;&amp; !Character.isWhitespace(key.charAt(index)))
<a class="jxr_linenumber" name="414" href="#414">414</a>         {
<a class="jxr_linenumber" name="415" href="#415">415</a>             index--;
<a class="jxr_linenumber" name="416" href="#416">416</a>         }
<a class="jxr_linenumber" name="417" href="#417">417</a>         <strong class="jxr_keyword">return</strong> index;
<a class="jxr_linenumber" name="418" href="#418">418</a>     }
<a class="jxr_linenumber" name="419" href="#419">419</a> 
<a class="jxr_linenumber" name="420" href="#420">420</a>     <em class="jxr_comment">// static initializer: registers the configuration node pointer factory</em>
<a class="jxr_linenumber" name="421" href="#421">421</a>     <strong class="jxr_keyword">static</strong>
<a class="jxr_linenumber" name="422" href="#422">422</a>     {
<a class="jxr_linenumber" name="423" href="#423">423</a>         JXPathContextReferenceImpl
<a class="jxr_linenumber" name="424" href="#424">424</a>                 .addNodePointerFactory(<strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/commons/configuration/tree/xpath/ConfigurationNodePointerFactory.html">ConfigurationNodePointerFactory</a>());
<a class="jxr_linenumber" name="425" href="#425">425</a>     }
<a class="jxr_linenumber" name="426" href="#426">426</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

